<!DOCTYPE HTML>

<html lang="en">
<head>

<title>PortMapperImpl (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="PortMapperImpl (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="PortMapperImpl.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="PortMapperImpl.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="PortMapperImpl.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="PortMapperImpl.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="PortMapperImpl.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.web</a></div>
<h2 title="Class PortMapperImpl" class="title">Class PortMapperImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.security.web.PortMapperImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="PortMapper.html" title="interface in org.springframework.security.web">PortMapper</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">PortMapperImpl</span>
extends java.lang.Object
implements <a href="PortMapper.html" title="interface in org.springframework.security.web">PortMapper</a></pre>
<div class="block">Concrete implementation of <a href="PortMapper.html" title="interface in org.springframework.security.web"><code>PortMapper</code></a> that obtains HTTP:HTTPS pairs from the
application context.
<p>
By default the implementation will assume 80:443 and 8080:8443 are HTTP:HTTPS pairs
respectively. If different pairs are required, use <a href="PortMapperImpl.html#setPortMappings(java.util.Map)"><code>setPortMappings(Map)</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="PortMapperImpl.html#%3Cinit%3E()">PortMapperImpl</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.Integer,&#8203;java.lang.Integer&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PortMapperImpl.html#getTranslatedPortMappings()">getTranslatedPortMappings</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the translated (Integer -&gt; Integer) version of the original port mapping
specified via setHttpsPortMapping()</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PortMapperImpl.html#lookupHttpPort(java.lang.Integer)">lookupHttpPort</a></span>&#8203;(java.lang.Integer&nbsp;httpsPort)</code></th>
<td class="colLast">
<div class="block">Locates the HTTP port associated with the specified HTTPS port.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PortMapperImpl.html#lookupHttpsPort(java.lang.Integer)">lookupHttpsPort</a></span>&#8203;(java.lang.Integer&nbsp;httpPort)</code></th>
<td class="colLast">
<div class="block">Locates the HTTPS port associated with the specified HTTP port.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="PortMapperImpl.html#setPortMappings(java.util.Map)">setPortMappings</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;newMappings)</code></th>
<td class="colLast">
<div class="block">Set to override the default HTTP port to HTTPS port mappings of 80:443, and
8080:8443.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PortMapperImpl</h4>
<pre>public&nbsp;PortMapperImpl()</pre>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="getTranslatedPortMappings()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>getTranslatedPortMappings</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.Integer,&#8203;java.lang.Integer&gt;&nbsp;getTranslatedPortMappings()</pre>
<div class="block">Returns the translated (Integer -&gt; Integer) version of the original port mapping
specified via setHttpsPortMapping()</div>
</li>
</ul>
<a id="lookupHttpPort(java.lang.Integer)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>lookupHttpPort</h4>
<pre class="methodSignature">public&nbsp;java.lang.Integer&nbsp;lookupHttpPort&#8203;(java.lang.Integer&nbsp;httpsPort)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="PortMapper.html#lookupHttpPort(java.lang.Integer)">PortMapper</a></code></span></div>
<div class="block">Locates the HTTP port associated with the specified HTTPS port.
<P>
Returns <code>null</code> if unknown.
</P></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="PortMapper.html#lookupHttpPort(java.lang.Integer)">lookupHttpPort</a></code>&nbsp;in interface&nbsp;<code><a href="PortMapper.html" title="interface in org.springframework.security.web">PortMapper</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the HTTP port or <code>null</code> if unknown</dd>
</dl>
</li>
</ul>
<a id="lookupHttpsPort(java.lang.Integer)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>lookupHttpsPort</h4>
<pre class="methodSignature">public&nbsp;java.lang.Integer&nbsp;lookupHttpsPort&#8203;(java.lang.Integer&nbsp;httpPort)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="PortMapper.html#lookupHttpsPort(java.lang.Integer)">PortMapper</a></code></span></div>
<div class="block">Locates the HTTPS port associated with the specified HTTP port.
<P>
Returns <code>null</code> if unknown.
</P></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="PortMapper.html#lookupHttpsPort(java.lang.Integer)">lookupHttpsPort</a></code>&nbsp;in interface&nbsp;<code><a href="PortMapper.html" title="interface in org.springframework.security.web">PortMapper</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the HTTPS port or <code>null</code> if unknown</dd>
</dl>
</li>
</ul>
<a id="setPortMappings(java.util.Map)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setPortMappings</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPortMappings&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;newMappings)</pre>
<div class="block">Set to override the default HTTP port to HTTPS port mappings of 80:443, and
8080:8443. In a Spring XML ApplicationContext, a definition would look something
like this:
<pre>  &lt;property name="portMappings"&gt;
      &lt;map&gt;
          &lt;entry key="80"&gt;&lt;value&gt;443&lt;/value&gt;&lt;/entry&gt;
          &lt;entry key="8080"&gt;&lt;value&gt;8443&lt;/value&gt;&lt;/entry&gt;
      &lt;/map&gt;
 &lt;/property&gt;
 </pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newMappings</code> - A Map consisting of String keys and String values, where for
each entry the key is the string representation of an integer HTTP port number, and
the value is the string representation of the corresponding integer HTTPS port
number.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if input map does not consist of String keys and
values, each representing an integer port number in the range 1-65535 for that
mapping.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="PortMapperImpl.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="PortMapperImpl.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="PortMapperImpl.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="PortMapperImpl.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="PortMapperImpl.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040e85b8e3897cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
